Skip to content

docs: clarify enter and stay causes for parameter changes - #7959

Open
Turtle-Hwan wants to merge 1 commit into
TanStack:mainfrom
Turtle-Hwan:docs/7795-enter-stay-causes
Open

docs: clarify enter and stay causes for parameter changes#7959
Turtle-Hwan wants to merge 1 commit into
TanStack:mainfrom
Turtle-Hwan:docs/7795-enter-stay-causes

Conversation

@Turtle-Hwan

@Turtle-Hwan Turtle-Hwan commented Aug 5, 2026

Copy link
Copy Markdown

What

Clarifies that cause follows the lifecycle of the route ID, including when path params or loaderDeps change. Adds the encoded parameter example from #7795 to show that a direct load uses enter, while navigation between values on an active route uses stay even when the match ID changes.

Closes #7795

Verification

  • pnpm test:docs (244 Markdown files, no broken links)
  • Prettier check for docs/router/guide/data-loading.md
  • git diff --check

Summary by CodeRabbit

  • Documentation
    • Clarified when data loaders run for active routes.
    • Explained that “stay” also applies when path parameters or loader dependencies change without changing the route.

@coderabbitai

coderabbitai Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 75f8bf13-72d9-4634-91c9-6034037aa14f

📥 Commits

Reviewing files that changed from the base of the PR and between 314098e and c91ec2a.

📒 Files selected for processing (1)
  • docs/router/guide/data-loading.md

📝 Walkthrough

Walkthrough

The data-loading guide clarifies that enter applies when a route ID becomes active, while stay applies when it remains active, including path parameter and loaderDeps changes.

Changes

Loader cause documentation

Layer / File(s) Summary
Clarify enter and stay causes
docs/router/guide/data-loading.md
The documentation defines route activation semantics for enter and stay, including path parameter and loaderDeps changes.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

  • TanStack/router#7949: Updates the same data-loading guide with related loader behavior clarifications.

Suggested labels: documentation

Suggested reviewers: sheraff

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the documentation change for enter and stay causes during parameter changes.
Linked Issues check ✅ Passed The documentation clarifies enter and stay by route lifecycle and explains behavior for parameter and loader dependency changes as required by issue #7795.
Out of Scope Changes check ✅ Passed The changes are limited to related documentation updates and include no unrelated code or public API changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: clarify enter and stay causes for parameter changes

1 participant